#region Using Directives and Copyright Notice

// Copyright (c) 2007-2010, Computer Consultancy Pty Ltd
// All rights reserved.
// 
// Redistribution and use in source and binary forms, with or without
// modification, are permitted provided that the following conditions are met:
//     * Redistributions of source code must retain the above copyright
//       notice, this list of conditions and the following disclaimer.
//     * Redistributions in binary form must reproduce the above copyright
//       notice, this list of conditions and the following disclaimer in the
//       documentation and/or other materials provided with the distribution.
//     * Neither the name of the Computer Consultancy Pty Ltd nor the
//       names of its contributors may be used to endorse or promote products
//       derived from this software without specific prior written permission.
// 
// THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" 
// AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 
// IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE 
// ARE DISCLAIMED. IN NO EVENT SHALL COMPUTER CONSULTANCY PTY LTD BE LIABLE 
// FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL 
// DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR 
// SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER 
// CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT 
// LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY 
// OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH
// DAMAGE.

using System;
using System.Collections.Generic;
using System.Text;

using Interlace.Collections;

using DatabaseCop.RuleHelpers;

#endregion

namespace DatabaseCop.Rules
{
    public class AvoidAbbreviations : Rule
    {
        static readonly Set<string> _ignoreWords = new Set<string>(
            "Bsb", "Gst", "Bas", "By", "Tfn", "Gvm");

        static readonly char[] _vowels = new char[] {
            'a', 'e', 'i', 'o', 'u', 'A', 'E', 'I', 'O', 'U' }; 

        public override void CheckColumn(ViolationReport report, Column column)
        {
            foreach (ParsedWord word in column.ParsedName.Words)
            {
                if (word.Value.IndexOfAny(_vowels) == -1 && !_ignoreWords.Contains(word.Value))
                {
                    report.AddViolation(column, string.Format(
                        "The word \"{0}\" in the column name appears to be an abbreviation (it does " +
                        "not contain any vowels, and it is not a very well known abbreviation such as \"GST\" or " +
                        "\"TFN\"). Abbreviations should in general never be used.", word.Value));
                }
            }
        }
    }
}
